Skip to content

Conversation

@ericcrosson-bitgo
Copy link
Contributor

This commit adds a new test case to verify that headers with the @Private JSDoc tag are correctly marked with x-internal in the OpenAPI specification. The test checks that:

  1. A header with @Private is marked with x-internal: true
  2. The description is preserved
  3. Public headers are not marked with x-internal
  4. The header is still required and has the correct schema type

The test uses a sample route with both a private and a public header to demonstrate the behavior.

Co-authored-by: aider aider@bitgo.com

This commit adds a new test case to verify that headers with the @Private JSDoc tag are correctly marked with x-internal in the OpenAPI specification. The test checks that:

1. A header with @Private is marked with x-internal: true
2. The description is preserved
3. Public headers are not marked with x-internal
4. The header is still required and has the correct schema type

The test uses a sample route with both a private and a public header to demonstrate the behavior.

Co-authored-by: aider <aider@bitgo.com>
@ericcrosson-bitgo ericcrosson-bitgo marked this pull request as ready for review February 6, 2025 23:42
@ericcrosson-bitgo ericcrosson-bitgo requested a review from a team as a code owner February 6, 2025 23:42
@ericcrosson-bitgo ericcrosson-bitgo merged commit 047d2f2 into BitGo:master Feb 7, 2025
6 checks passed
@github-actions
Copy link

github-actions bot commented Feb 7, 2025

🎉 This PR is included in version @api-ts/openapi-generator@5.6.0 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

@github-actions
Copy link

🎉 This PR is included in version @api-ts/typed-express-router@2.0.0-beta.1 🎉

The release is available on npm package (@beta dist-tag)

Your semantic-release bot 📦🚀

@github-actions
Copy link

🎉 This PR is included in version @api-ts/express-wrapper@2.0.0-beta.1 🎉

The release is available on npm package (@beta dist-tag)

Your semantic-release bot 📦🚀

@github-actions
Copy link

🎉 This PR is included in version @api-ts/typed-express-router@1.1.14 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

@github-actions
Copy link

🎉 This PR is included in version @api-ts/express-wrapper@1.0.34 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

@github-actions
Copy link

🎉 This PR is included in version @api-ts/superagent-wrapper@1.3.4 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant